Fix Sphinx documentation warnings - #515
Conversation
- Updated parameter descriptions in `build_constant_slab_plasma` to use proper formatting for units. - Changed class definitions in `pipelines.py` to remove unnecessary parentheses and improved unit formatting in comments. - Modified documentation in `custom_models.rst` to reference the correct class path for `InhomogeneousVolumeEmitter`. - Enhanced mathematical notation in `charge_exchange_calculation.rst` for better readability and consistency. - Corrected unit formatting across various documentation files to use LaTeX-style notation for clarity.
|
I think Since most cases of ^2 --> ² (U+00B2)
I actually think readability of docstrings/comments in source code is more important than strict typographical correctness, as long as the HTML renders "well enough." For RST in the One thing which would help is by converting docstrings with LaTeX expressions to raw strings |
|
I also wonder whether some of the more equation-heavy docstrings would be better split up: have sections in the relevant rst file in @munechika-koyo can you create an issue where we can discuss this further before revisiting this PR, if there isn't one already? |
|
Using a Unicode suffix/superscript looks much better if available.
I agree with you.
Sure, I will. |
|
Created #516 to discuss the docstring/documentation split and formatting guidelines before revisiting this PR. |
Summary
Example changes